`Modeling exercises`: Fix submission error and redundant tooltip for AI feedback #9437

LeonWehrhahn · 2024-10-07T15:58:14Z

Checklist

General

I tested all changes and their related features with all corresponding user types on a test server.
This is a small issue that I tested locally and was confirmed by another developer on a test server.
Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
I chose a title conforming to the naming conventions for pull requests.

Server

Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
I strictly followed the principle of data economy for all database calls.
I strictly followed the server coding and design guidelines.
I added multiple integration tests (Spring) related to the features (with a high test coverage).
I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
I documented the Java code using JavaDoc style.

Client

Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
I strictly followed the principle of data economy for all client-server REST calls.
I strictly followed the client coding and design guidelines.
Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
I documented the TypeScript code using JSDoc style.
I added multiple screenshots/screencasts of my UI changes.
I translated all newly inserted strings into English and German.

Changes affecting Programming Exercises

High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).
I tested all changes and their related features with all corresponding user types on a test server configured with Gitlab and Jenkins.

Motivation and Context

Prerequisites:

The user is working on a modeling exercise with AI feedback generation enabled.

The Problem:

When a user submits an updated model after the first AI feedback generation request has been processed, and is still in the modeling editor when the feedback result is returned, submitting the updated model can result in a server error on the first attempt.
Additionally, when a user opens the modeling editor and an AI feedback result is present, the editor always displays a tooltip indicating that a new assessment is available.

Description

The submission issue occurs because the new AI feedback result is not correctly associated with the modelingSubmission object on the client-side. This causes the server to assume that no result is linked to the current submission, leading to errors. The PR ensures that the server-side checks for results associated with the modelingSubmission before proceeding, preventing errors.

The PR also prevents the tooltip indicating "New Assessment Available" from appearing unnecessarily for AI-generated preliminary feedback results, improving the user experience by removing the redundant notification.

Steps for Testing

Only Deploy to TS1

Instructor Setup:

Create a new modeling exercise with the AI feedback option enabled.
Optionally, include grading instructions to guide the assessment.

Student Participation:

Log in as a student, submit a solution for the modeling exercise, and request AI feedback. To request AI feedback, click on the "Request AI feedback" button.
Go directly back into the modeling editor and wait for the feedback to be completed.

Check:

Edit the existing UML diagram and click on submit again. Check if the submission works without getting a server error.

Exam Mode Testing

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Performance Review

I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Exam Mode Test

Test 1
Test 2

Performance Tests

Test 1
Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

New Features
- Introduced a method to check for existing results by submission ID.
- Enhanced filtering logic for results based on exercise types, including modeling exercises.
- Added support for feedback requests for both text and modeling exercises.
- Improved handling of submission results to ensure only relevant results are included.
- Expanded functionality to support file upload exercises and modeling exercises.
Bug Fixes
- Improved handling of submission results to exclude null values.
- Refined logic for displaying assessment notifications based on assessment types.
Documentation
- Updated method documentation to reflect changes in functionality and return values.
Tests
- Expanded test coverage for modeling submissions and feedback requests, including success and failure scenarios.
Style
- Improved code readability and maintainability through refined comments and streamlined logic.

…can continue working

https://github.com/ls1intum/Artemis into feature/text-exercises/immediate-preliminary-feedback

…ary-feedback

https://github.com/ls1intum/Artemis into feature/text-exercises/immediate-preliminary-feedback

…edback-submission

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range comments (1)

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java (1)
Line range hint 236-249: LGTM! Consider a minor improvement in variable naming.

The new method setNumberOfAffectedSubmissionsPerElement is well-implemented and aligns with the single responsibility principle. It effectively calculates and sets the number of similar elements for a given modeling submission.

Consider renaming the modelElementCount variable in the stream operation to improve clarity:
-elementCounts.stream().map(modelElementCount -> {
+elementCounts.stream().map(elementCount -> {
     SimilarElementCount similarElementCount = new SimilarElementCount();
-    similarElementCount.setElementId(modelElementCount.getElementId());
-    similarElementCount.setNumberOfOtherElements(modelElementCount.getNumberOfOtherElements());
+    similarElementCount.setElementId(elementCount.getElementId());
+    similarElementCount.setNumberOfOtherElements(elementCount.getNumberOfOtherElements());
     return similarElementCount;
 }).collect(Collectors.toSet()));
This change makes it clearer that we're mapping from ModelElementCount to SimilarElementCount.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 1255ae5 and a192afe.

📒 Files selected for processing (1)

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

github-actions · 2024-10-08T01:28:59Z

⚠️ Unable to deploy to test servers ⚠️

The docker build needs to run through before deploying.

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range comments (1)

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java (1)
Line range hint 228-240: LGTM! Consider adding a brief comment for clarity.

The new method setNumberOfAffectedSubmissionsPerElement is well-implemented and follows good coding practices. It effectively sets the number of potential automatic feedback for each model element.

Consider adding a brief comment before the stream operation to explain the transformation:
// Transform ModelElementCount objects to SimilarElementCount objects
submission.setSimilarElements(elementCounts.stream().map(modelElementCount -> {
    // ... (existing code)
}).collect(Collectors.toSet()));
This addition would enhance code readability and make the purpose of the stream operation more explicit.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between a192afe and d18df7b.

📒 Files selected for processing (1)

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java

undernagruzez

code lgtm
also works as expected on ts1

EneaGore

Tested on ts1. Code also lgtm.

…edback-submission

ole-ve

code

= Enea_Gore and others added 30 commits August 4, 2024 20:33

add UI options for AI Feedback and result history

f03e5e5

Add Athena Feedback option for text exercises

1067ef1

Add Athena AI Feedback button and history to Text Exercises

80242a0

Add check for automatic Athena results in code editor so the student …

0245572

…can continue working

Update result components for Text Feedback

992a2bd

Handle toggle of athena ai feedback request option

b49ca0f

Get the last submission for assessment for text exercises

b79d325

Preliminary Feedback Server

c79b540

Fix Assessment tutor side issues

5405ae1

remove todo

9ddc3d9

Merge branch 'feature/text-exercises/immediate-preliminary-feedback' of

01159dc

https://github.com/ls1intum/Artemis into feature/text-exercises/immediate-preliminary-feedback

Merge branch 'develop' into feature/text-exercises/immediate-prelimin…

79c4739

…ary-feedback

prettier

a5b1c45

Formattierung

da61ffa

Merge branch 'feature/text-exercises/immediate-preliminary-feedback' of

95895b1

https://github.com/ls1intum/Artemis into feature/text-exercises/immediate-preliminary-feedback

Improve results for preliminary text AI Feedback

f1cf351

Fix result icon and color for Ai Feedback

1c6ac3d

typo

52083fe

ups

6070cb6

typo

44f8cef

improve result strings for text ai feedback

ac360d4

set ai feedback for text to graded

3de99f0

add spinner for ai feedback

2f99541

small improvements

d1a30f7

fix rate limit and editor sign when athena results

b192080

clean up code

69a179e

revert last change partially

c8f5526

turn off automatic feedback requests if no module selected

f6e5aef

update string for successful and failed athena feedback

753c050

refactor feedback request (Thanks Leon)

a175663

LeonWehrhahn changed the title ~~Modeling: Fix Server-Side Submission Error and Redundant Tooltip for AI Feedback in Modeling Exercises~~ Modeling Exercises : Fix Server-Side Submission Error and Redundant Tooltip for AI Feedback Oct 7, 2024

LeonWehrhahn changed the title ~~Modeling Exercises : Fix Server-Side Submission Error and Redundant Tooltip for AI Feedback~~ Modeling Exercises: Fix Server-Side Submission Error and Redundant Tooltip for AI Feedback Oct 7, 2024

LeonWehrhahn and others added 2 commits October 8, 2024 03:05

Add null check

f6470c6

Merge branch 'develop' into feature/modeling-exercises/preliminary-fe…

a192afe

…edback-submission

coderabbitai bot requested changes Oct 8, 2024

View reviewed changes

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java Outdated Show resolved Hide resolved

Update comment

d18df7b

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

LeonWehrhahn added the deploy:artemis-test1 label Oct 8, 2024

github-actions bot removed the deploy:artemis-test1 label Oct 8, 2024

github-actions bot added the deployment-error Added by deployment workflows if an error occured label Oct 8, 2024

LeonWehrhahn added the deploy:artemis-test1 label Oct 8, 2024

github-actions bot removed the deployment-error Added by deployment workflows if an error occured label Oct 8, 2024

LeonWehrhahn temporarily deployed to artemis-test1.artemis.cit.tum.de October 8, 2024 01:35 — with GitHub Actions Inactive

coderabbitai bot requested changes Oct 8, 2024

View reviewed changes

src/main/java/de/tum/cit/aet/artemis/modeling/service/ModelingSubmissionService.java Show resolved Hide resolved

github-actions bot added lock:artemis-test1 and removed deploy:artemis-test1 labels Oct 8, 2024

LeonWehrhahn added the ready for review label Oct 8, 2024

undernagruzez approved these changes Oct 8, 2024

View reviewed changes

EneaGore approved these changes Oct 8, 2024

View reviewed changes

MaximilianAnzinger changed the title ~~Modeling Exercises: Fix Server-Side Submission Error and Redundant Tooltip for AI Feedback~~ Modeling exercises: Fix server-side submission error and redundant tooltip for ai feedback Oct 9, 2024

EneaGore removed the lock:artemis-test1 label Oct 9, 2024

Merge branch 'develop' into feature/modeling-exercises/preliminary-fe…

8fa6f9b

…edback-submission

ole-ve approved these changes Oct 11, 2024

View reviewed changes

krusche changed the title ~~Modeling exercises: Fix server-side submission error and redundant tooltip for ai feedback~~ Modeling exercises: Fix submission error and redundant tooltip for AI feedback Oct 12, 2024

krusche added this to the 7.6.0 milestone Oct 12, 2024

krusche approved these changes Oct 12, 2024

View reviewed changes

krusche merged commit d8c99a2 into develop Oct 12, 2024
22 of 29 checks passed

krusche deleted the feature/modeling-exercises/preliminary-feedback-submission branch October 12, 2024 17:15

This was referenced Oct 12, 2024

Text exercises: Replace feedback modal with inline feedback view #9395

Open

Iris: Enable Iris for exercises based on their categories #9461

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Modeling exercises`: Fix submission error and redundant tooltip for AI feedback #9437

`Modeling exercises`: Fix submission error and redundant tooltip for AI feedback #9437

LeonWehrhahn commented Oct 7, 2024 •

edited by sachmii

Loading

coderabbitai bot left a comment

github-actions bot commented Oct 8, 2024

coderabbitai bot left a comment

undernagruzez left a comment

EneaGore left a comment

ole-ve left a comment

Modeling exercises: Fix submission error and redundant tooltip for AI feedback #9437

Modeling exercises: Fix submission error and redundant tooltip for AI feedback #9437

Conversation

LeonWehrhahn commented Oct 7, 2024 • edited by sachmii Loading

Checklist

General

Server

Client

Changes affecting Programming Exercises

Motivation and Context

Description

Steps for Testing

Exam Mode Testing

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Exam Mode Test

Performance Tests

Test Coverage

Screenshots

Summary by CodeRabbit

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 8, 2024

⚠️ Unable to deploy to test servers ⚠️

coderabbitai bot left a comment

Choose a reason for hiding this comment

undernagruzez left a comment

Choose a reason for hiding this comment

EneaGore left a comment

Choose a reason for hiding this comment

ole-ve left a comment

Choose a reason for hiding this comment

`Modeling exercises`: Fix submission error and redundant tooltip for AI feedback #9437

`Modeling exercises`: Fix submission error and redundant tooltip for AI feedback #9437

LeonWehrhahn commented Oct 7, 2024 •

edited by sachmii

Loading